cs-arl-xapi

La API cs-ARL-xapi es un servicio web que funciona como capa de experiencia (xapi) para el sistema de la ARL de Colmena. Esta API proporciona acceso controlado y seguro a las funcionalidades principales de gestión de trabajadores dependientes, sirviendo como único punto de entrada para entidades externas que requieren integración con el sistema ARL.

Como capa de experiencia, la API cs-arl-xapi abstrae la complejidad del sistema interno y expone únicamente dos métodos esenciales que cubren los casos de uso principales para la gestión de trabajadores dependientes.

📊 Diagrama de Arquitectura

Componentes del Sistema:

🏢 Capa Externa - Empresas

• Función: Punto de entrada para clientes externos
• Operaciones: Consultar, crear y retirar trabajadores
• Resultado: Recibe hash de confirmación de transacciones

🔒 Capa de Seguridad - Endpoint Colmena

• Autenticación: Validación de credenciales y tokens
• Auditoría: Registro completo de todas las operaciones
• Trazabilidad: Seguimiento de cada transacción

🎯 Capa de API - Portal Cliente API Audit

• Validación: Verificación de contratos y datos
• Registro: Almacenamiento de logs de auditoría
• Procesamiento: Gestión de requests y responses

💾 Capa Core - Sistemas Core

• Almacenamiento: Base de datos principal
• Procesamiento: Lógica de negocio central
• Integración: Comunicación con sistemas internos

🔐 Seguridad y Trazabilidad

Hash de Seguridad:

SHA-256 = token + Contrato + Usuario + Operación

Componentes del Hash:

• Token: Token de autenticación OAuth 2.0
• Contrato: Número consecutivo del contrato
• Usuario: Información del usuario que ejecuta la operación
• Operación: Tipo de transacción (Crear/Retirar)

🔄 Proceso de Consumo de la API

Flujo de Ingreso de Trabajador Dependiente

Paso 1: Autenticación

sequenceDiagram
    participant E as Empresa (Cliente)
    participant A as API Autenticación
    participant X as API CS-arl-xapi
    participant S as Sistema ARL Colmena

    E->>A: 1. POST /token
    A->>E: 2. access_token (Bearer + client + grant_type)
    Note over E: Token válido por 1 hora

Paso 2: Procesamiento de Solicitud

sequenceDiagram
    participant E as Empresa (Cliente)
    participant X as API CS-arl-xapi
    participant S as Sistema ARL Colmena

    E->>X: 3. POST /create-dependent-worker
    Note over X: Headers: Authorization Bearer + Data
    X->>X: 4. Validar Token
    X->>X: 5. Validar Request
    X->>S: 6. Procesar Ingreso
    S->>S: Guardar en BD
    S->>E: Response con hash

📋 Detalles del Proceso

🔑 Autenticación (Pasos 1-2)

1. POST /token: Cliente solicita token de acceso
2. Response: Sistema devuelve access_token con validez de 1 hora

📝 Procesamiento (Pasos 3-6)

1. POST /create-dependent-worker: Cliente envía datos del trabajador
2. Validar Token: API verifica autenticación y autorización
3. Validar Request: Sistema valida formato y contenido de datos
4. Procesar Ingreso: Almacenamiento en base de datos y generación de hash

🎯 Flujos de Proceso

📥 Ingreso de Trabajador

Empresa → Autenticación → Validación → Procesamiento → Confirmación

📤 Retiro de Trabajador

Empresa → Autenticación → Identificación → Retiro → Confirmación

📊 Consulta de Referencias

Empresa → Autenticación → Solicitud → Catálogo → Respuesta

⚙️ Componentes Técnicos

🔐 Autenticación OAuth 2.0

• Grant Type: Client Credentials
• Duración: 3600 segundos (1 hora)
• Renovación: Automática antes del vencimiento

🛡️ Validaciones de Seguridad

• Token Bearer: Verificación en cada request
• Client Credentials: Validación de client_id y client_secret
• Hash SHA-256: Integridad de transacciones
• Audit Trail: Registro completo de operaciones

📡 Comunicación API

• Protocolo: HTTPS exclusivamente
• Formato: JSON para requests y responses
• Headers: Obligatorios para autenticación y auditoría
• Timeouts: Configurados para optimizar performance

🔍 Monitoreo y Auditoría

📊 Métricas de Sistema

• Latencia: Tiempo de respuesta por endpoint
• Throughput: Requests por segundo
• Errores: Rate de errores por tipo
• Disponibilidad: Uptime del servicio

🔒 Auditoría de Seguridad

• Accesos: Log de todos los intentos de autenticación
• Operaciones: Registro de todas las transacciones
• Errores: Detalle de fallas de seguridad
• Hash Verification: Validación de integridad

📈 Escalabilidad y Performance

⚡ Optimizaciones

• Caching: Datos de referencia en memoria
• Connection Pooling: Reutilización de conexiones
• Load Balancing: Distribución de carga
• Rate Limiting: Control de requests por cliente

🔄 Recuperación y Continuidad

• Retry Logic: Reintentos automáticos
• Circuit Breaker: Protección contra fallos
• Backup Systems: Sistemas de respaldo
• Disaster Recovery: Plan de recuperación

💡 Nota: Estos diagramas representan la arquitectura actual de la API cs-ARL-xapi v1.0.0. Para actualizaciones del sistema, consulte la documentación oficial en el portal de MuleSoft Exchange.